<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CheeseEffect: Cheese Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Cheese Reference Manual">
<link rel="up" href="libcheese.html" title="libcheese">
<link rel="prev" href="CheeseCameraDeviceMonitor.html" title="CheeseCameraDeviceMonitor">
<link rel="next" href="CheeseFileUtil.html" title="CheeseFileUtil">
<meta name="generator" content="GTK-Doc V1.29.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#CheeseEffect.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#CheeseEffect.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#CheeseEffect.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libcheese.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="CheeseCameraDeviceMonitor.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="CheeseFileUtil.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="CheeseEffect"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CheeseEffect.top_of_page"></a>CheeseEffect</span></h2>
<p>CheeseEffect — An effect to apply to a video capture stream</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="CheeseEffect.stability-level"></a><h2>Stability Level</h2>
<acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.

The Unstable interface level is a warning that these interfaces are  subject to
change without warning and should not be used in unbundled products.

Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="CheeseEffect.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="returnvalue">CheeseEffect</span></a> *
</td>
<td class="function_name">
<a class="link" href="CheeseEffect.html#cheese-effect-new" title="cheese_effect_new ()">cheese_effect_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="CheeseEffect.html#cheese-effect-get-name" title="cheese_effect_get_name ()">cheese_effect_get_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="CheeseEffect.html#cheese-effect-get-pipeline-desc" title="cheese_effect_get_pipeline_desc ()">cheese_effect_get_pipeline_desc</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="CheeseEffect.html#cheese-effect-enable-preview" title="cheese_effect_enable_preview ()">cheese_effect_enable_preview</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="CheeseEffect.html#cheese-effect-disable-preview" title="cheese_effect_disable_preview ()">cheese_effect_disable_preview</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="CheeseEffect.html#cheese-effect-is-preview-connected" title="cheese_effect_is_preview_connected ()">cheese_effect_is_preview_connected</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GList</span> *
</td>
<td class="function_name">
<a class="link" href="CheeseEffect.html#cheese-effect-load-effects" title="cheese_effect_load_effects ()">cheese_effect_load_effects</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="returnvalue">CheeseEffect</span></a> *
</td>
<td class="function_name">
<a class="link" href="CheeseEffect.html#cheese-effect-load-from-file" title="cheese_effect_load_from_file ()">cheese_effect_load_from_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="CheeseEffect.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<span class="type">GstElement</span> *</td>
<td class="property_name"><a class="link" href="CheeseEffect.html#CheeseEffect--control-valve" title="The “control-valve” property">control-valve</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="CheeseEffect.html#CheeseEffect--name" title="The “name” property">name</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="CheeseEffect.html#CheeseEffect--pipeline-desc" title="The “pipeline-desc” property">pipeline-desc</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="CheeseEffect.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="CheeseEffect.html#CheeseEffect-struct" title="CheeseEffect">CheeseEffect</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="CheeseEffect.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> CheeseEffect
</pre>
</div>
<div class="refsect1">
<a name="CheeseEffect.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;cheese/cheese-effect.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="CheeseEffect.description"></a><h2>Description</h2>
<p><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> provides an abstraction of an effect to apply to a stream
from a video capture device.</p>
</div>
<div class="refsect1">
<a name="CheeseEffect.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="cheese-effect-new"></a><h3>cheese_effect_new ()</h3>
<pre class="programlisting"><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="returnvalue">CheeseEffect</span></a> *
cheese_effect_new (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                   <em class="parameter"><code>const <span class="type">gchar</span> *pipeline_desc</code></em>);</pre>
<p>Create a new <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a>.</p>
<div class="refsect3">
<a name="cheese-effect-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>name of the effect</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pipeline_desc</p></td>
<td class="parameter_description"><p>GStreamer pipeline of the new effect</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="cheese-effect-new.returns"></a><h4>Returns</h4>
<p>a new <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cheese-effect-get-name"></a><h3>cheese_effect_get_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
cheese_effect_get_name (<em class="parameter"><code><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> *effect</code></em>);</pre>
<p>Get the human-readable name of the <em class="parameter"><code>effect</code></em>
.</p>
<div class="refsect3">
<a name="cheese-effect-get-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>effect</p></td>
<td class="parameter_description"><p>a <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="cheese-effect-get-name.returns"></a><h4>Returns</h4>
<p>the human-readable name of the effect. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cheese-effect-get-pipeline-desc"></a><h3>cheese_effect_get_pipeline_desc ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
cheese_effect_get_pipeline_desc (<em class="parameter"><code><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> *effect</code></em>);</pre>
<p>Get the Gstreamer pipeline description of the <em class="parameter"><code>effect</code></em>
.</p>
<div class="refsect3">
<a name="cheese-effect-get-pipeline-desc.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>effect</p></td>
<td class="parameter_description"><p>a <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="cheese-effect-get-pipeline-desc.returns"></a><h4>Returns</h4>
<p>the Gstreamer pipeline description of the effect. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cheese-effect-enable-preview"></a><h3>cheese_effect_enable_preview ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cheese_effect_enable_preview (<em class="parameter"><code><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> *effect</code></em>);</pre>
<p>Enable the preview of a <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a>.</p>
<div class="refsect3">
<a name="cheese-effect-enable-preview.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>effect</p></td>
<td class="parameter_description"><p>the <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> to enable the preview of</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cheese-effect-disable-preview"></a><h3>cheese_effect_disable_preview ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cheese_effect_disable_preview (<em class="parameter"><code><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> *effect</code></em>);</pre>
<p>Disable the preview of a <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a>.</p>
<div class="refsect3">
<a name="cheese-effect-disable-preview.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>effect</p></td>
<td class="parameter_description"><p>the <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> to disable the preview of</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cheese-effect-is-preview-connected"></a><h3>cheese_effect_is_preview_connected ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
cheese_effect_is_preview_connected (<em class="parameter"><code><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a> *effect</code></em>);</pre>
<p>Get whether the <em class="parameter"><code>effect</code></em>
 is connected to a video stream, for previews.</p>
<div class="refsect3">
<a name="cheese-effect-is-preview-connected.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>effect</p></td>
<td class="parameter_description"><p>a <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="cheese-effect-is-preview-connected.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the preview is connected, <code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cheese-effect-load-effects"></a><h3>cheese_effect_load_effects ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> *
cheese_effect_load_effects (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Load effects from standard directories, including the user's data directory.</p>
<div class="refsect3">
<a name="cheese-effect-load-effects.returns"></a><h4>Returns</h4>
<p>a list of
<a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a>, or <code class="literal">NULL</code> if no effects could be found. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Cheese.Effect][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cheese-effect-load-from-file"></a><h3>cheese_effect_load_from_file ()</h3>
<pre class="programlisting"><a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="returnvalue">CheeseEffect</span></a> *
cheese_effect_load_from_file (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre>
<p>Load effect from file.</p>
<div class="refsect3">
<a name="cheese-effect-load-from-file.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>name of the file containing the effect
specification. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="cheese-effect-load-from-file.returns"></a><h4>Returns</h4>
<p>a <a class="link" href="CheeseEffect.html" title="CheeseEffect"><span class="type">CheeseEffect</span></a>, or <code class="literal">NULL</code> on error. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="CheeseEffect.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="CheeseEffect-struct"></a><h3>CheeseEffect</h3>
<pre class="programlisting">typedef struct _CheeseEffect CheeseEffect;</pre>
<p>Use the accessor functions below.</p>
</div>
</div>
<div class="refsect1">
<a name="CheeseEffect.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="CheeseEffect--control-valve"></a><h3>The <code class="literal">“control-valve”</code> property</h3>
<pre class="programlisting">  “control-valve”            <span class="type">GstElement</span> *</pre>
<p>If the control valve is active, then the effect is currently connected to
a video stream, for previews.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="CheeseEffect--name"></a><h3>The <code class="literal">“name”</code> property</h3>
<pre class="programlisting">  “name”                     <span class="type">gchar</span> *</pre>
<p>Name of the effect, for display in a UI.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="CheeseEffect--pipeline-desc"></a><h3>The <code class="literal">“pipeline-desc”</code> property</h3>
<pre class="programlisting">  “pipeline-desc”            <span class="type">gchar</span> *</pre>
<p>Description of the GStreamer pipeline associated with the effect.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: ""</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.29.1</div>
</body>
</html>